バージョン: DAI 25.2

API V1 Endpoints

Eggplant パブリック API

Version 1.0

パステーブル

メソッド	パス	説明
POST	/auth	クライアントIDとシークレットからアクセストークンを取得する
GET	/test_results	テスト結果の一覧表示
GET	/test_results/{test_result_id}	単一のテストの結果を取得する
GET	/test_results/{test_result_id}/screenshots	テストに利用可能なスクリーンショットを一覧表示する
GET	/screenshots/{screenshot_id}	テスト結果のスクリーンショットをダウンロードする

参照表

名前	タイプ	説明
AuthRequestBody	スキーマ
AuthResponseBody	スキーマ
HTTPValidationError	スキーマ
Problem	スキーマ
RunType	スキーマ	特定のテスト結果に対して可能な実行タイプ。
Screenshot	スキーマ	特定のテスト結果の利用可能なスクリーンショットの情報。
スクリーンショットのページ区切りリスト	スキーマ	利用可能な単一のテスト結果のスクリーンショットのページ分けされたリスト。
Severity	スキーマ	単一のテスト結果ログエントリの重大度レベル。
SortBy	スキーマ	テスト結果のリストを並べ替えるために使用できる並べ替えオプション。
SortDirection	スキーマ	ソート中に適用される可能性のある方向。
Status	スキーマ	特定のテスト結果の可能なステータス。
TestResult	スキーマ	単一の探索、再生、またはテストケース実行に関するすべての情報が含まれるテスト結果。
TestResultLogEntriesPaginatedList	スキーマ	単一のテスト結果のログエントリのページ分けされたリスト。
TestResultLogEntry	スキーマ	特定のテスト結果からの単一のログエントリ。
テスト結果ページ区切りリスト	スキーマ	テスト結果のページ分けされたリスト。
ValidationError	スキーマ

パスの詳細

[POST] /auth

まとめ:
クライアントIDとシークレットからアクセストークンを取得する

RequestBody

application/json

{
  client_id: string
  client_secret: string
}

レスポンス

200 OK

application/json

{
  access_token: string
  expires_in: integer
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

422 検証エラー

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

[GET] /test_results

まとめ:
テスト結果の一覧表示

説明:
適用されたフィルターに一致するテスト結果のページ区切りリストを取得します。

パラメータ (クエリ)

// 
// 適用されたフィルターに一致するが、返されるリストから除外される、開始時のテスト結果の数。
// 
offset: integer

// 返されるテスト結果の最大数。<br>*注*: 制限の最大値は、システム環境変数のLIMIT_MAX_VALUEを設定することで変更できます。LIMIT_MAX_VALUEの許容範囲は1000～2147483647です。
limit: integer //default: 1000

// 
// 返されるテスト結果項目の順序を決定するために使用されるキー。
// 
sort_by: SortBy

// 
// ソート時にテスト結果項目に適用される順序方向。
// 
sort_direction: SortDirection

//
// 特定のテスト結果ステータスでテスト結果をフィルタリングします。
//
status: Status

//
// テスト結果をフィルタリングして、指定された時間以降に開始されたものを取得します。<br>
// *デフォルト値* : null
//
start_time: 文字列

//
// 指定された時間より前に終了したテスト結果を取得するためにフィルター処理します。<br>
// *デフォルト値* : null
//
end_time: string

/
// テスト結果をフィルタリングして、指定された model_id.<br> に一致するモデルを使用するテスト結果を取得します
// *デフォルト値* : null
//
model_id: string

//
// テスト結果をフィルタリングして、指定された suite_id.<br> に一致するスイートを使用するスクリプト化されたテスト結果を取得します
// *デフォルト値* : null
//
suite_id:string

//
// 指定された test_case_id.<br> のすべてのテスト結果を取得します。
// *デフォルト値* : null
//
test_case_id: string

//
// この実行環境 ID を実行に使用したすべてのテスト結果を取得します。<br>
// *デフォルト値* : null
//
execution_environment_id: integer

//
// この sut_id に一致する sut を実行に使用したすべてのテスト結果を取得します。<br>
// *デフォルト値* : null
//
sut_id: string

//
// 指定された task_instance_id.<br> に一致するテスト構成実行に含まれるすべてのテスト結果を取得します。
// *デフォルト値* : null
//
test_config_result_id: string

//
// 指定された test_config_id.<br> のすべてのテスト結果を取得します。
// *デフォルト値* : null
//
test_config_id: string

ヘッダー

// POST /auth エンドポイントから返される access_token。
authorization: string

Responses

200 OK

application/json

// テスト結果のページ区切りリスト。
{
// 制限またはオフセットが適用される前の、リクエストに一致するアイテムの合計数。
total_count: integer
// このリクエストが行われた日時。
date_as_of: string
// 単一の探索、再生、またはテスト ケース実行のすべての情報を含むテスト結果。
items: {
// テスト結果 ID。
id: integer
// 特定のテスト結果の可能なステータス。
status: enum[RUNNING、PASSED、FAILED、ERROR、CANCELLED]
// 特定のテスト結果の可能な実行タイプ。
run_type: enum[SCRIPTED_TEST_CASE、MODEL_TEST_CASE、EXPLORATORY、REPLAY]
// このテスト結果が、テスト構成で構成された再実行試行の一部であったかどうか。
is_rerun: boolean
// テスト実行が開始された時刻。
start_time: string
// テスト実行が完了した時刻。まだ実行中の場合、これは null になります。
end_time: Partial(string) & Partial(null)
// テスト実行に使用されたモデルの名前。これがスクリプト化されたテスト ケースの結果である場合、これは null になります。
model_name: Partial(string) & Partial(null)
// テスト実行に使用されたモデルの ID。これがスクリプト化されたテスト ケースの結果である場合、これは null になります。
model_id: Partial(string) & Partial(null)
// テスト実行に使用されたスイートの名前。
suite_name: Partial(string) & Partial(null)
// テスト実行に使用されたスイートの ID。
suite_id: Partial(string) & Partial(null)
// 実行中のテスト ケースの名前。探索的テストまたは再生テストの結果の場合、これは null になります。
test_case_name: Partial(string) & Partial(null)
// 実行されたテスト ケースの ID。探索的または再生テスト結果の場合、これは null になります。
test_case_id: Partial(string) & Partial(null)
// テスト実行に使用される設計エージェントまたは実行エージェントの名前
execution_environment_name: Partial(string) & Partial(null)
// テスト実行に使用される設計エージェントまたは実行エージェントの ID。
execution_environment_id: Partial(integer) & Partial(null)
// テスト実行に使用される SUT の名前。
sut_name: Partial(string) & Partial(null)
// テスト実行に使用される SUT の ID。
sut_id: Partial(string) & Partial(null)
// このテスト結果が含まれるテスト構成結果の ID。ライブ実行の場合、これは null になります。
test_config_result_id: Partial(string) & Partial(null)
// このテスト結果が表すテスト構成ステップ。これはゼロインデックスで、ライブ実行結果の場合は null になります。
test_config_step: Partial(integer) & Partial(null)
}[]
}

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

422 検証エラー

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

[GET] /test_results/{test_result_id}

まとめ:
単一のテストの結果を取得する

説明:
指定された test_result_id のテスト結果を取得します。

Headers

// POST /auth エンドポイントから返される access_token。
authorization: string

レスポンス

200 テスト結果が正常に取得されました

application/json

// 単一の探索、再生、またはテスト ケース実行に関するすべての情報を含むテスト結果。
{
// テスト結果 ID。
id: integer
// 特定のテスト結果の可能なステータス。
status: enum[RUNNING、PASSED、FAILED、ERROR、CANCELLED]
// 特定のテスト結果の可能な実行タイプ。
run_type: enum[SCRIPTED_TEST_CASE、MODEL_TEST_CASE、EXPLORATORY、REPLAY]
// このテスト結果が、テスト構成で構成された再実行試行の一部であったかどうか。
is_rerun: boolean
// テスト実行が開始された時刻。
start_time: string
// テスト実行が完了した時刻。まだ実行中の場合は null になります。
end_time: Partial(string) & Partial(null)
// テスト実行に使用されたモデルの名前。これがスクリプト化されたテスト ケース結果だった場合は null になります。
model_name: Partial(string) & Partial(null)
// テスト実行に使用されたモデルの ID。これがスクリプト化されたテスト ケースの結果である場合、これは null になります。
model_id: Partial(string) & Partial(null)
// テスト実行に使用されたスイートの名前。
suite_name: Partial(string) & Partial(null)
// テスト実行に使用されたスイートの ID。
suite_id: Partial(string) & Partial(null)
// 実行中のテスト ケースの名前。探索的または再生テストの結果の場合、これは null になります。
test_case_name: Partial(string) & Partial(null)
// 実行されたテスト ケースの ID。探索的または再生テストの結果の場合、これは null になります。
test_case_id: Partial(string) & Partial(null)
// テスト実行に使用される設計エージェントまたは実行エージェントの名前
execution_environment_name: Partial(string) & Partial(null)
// テスト実行に使用される設計エージェントまたは実行エージェントの ID。
execution_environment_id: Partial(integer) & Partial(null)
// テスト実行に使用される SUT の名前。
sut_name: Partial(string) & Partial(null)
// テスト実行に使用される SUT の ID。
sut_id: Partial(string) & Partial(null)
// このテスト結果が含まれるテスト構成結果の ID。ライブ実行の場合、これは null になります。
test_config_result_id: Partial(string) & Partial(null)
// このテスト結果が表すテスト構成ステップ。これはゼロインデックスで、ライブ実行結果の場合は null になります。
test_config_step: Partial(integer) & Partial(null)
}

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

403 アクセスが拒否されました

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

404 テスト結果が見つかりません

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

422 検証エラー

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

[GET] /test_results/{test_result_id}/logs

まとめ:
単一のテストのログを取得する

説明:
単一のテスト結果のログのページ分割されたリストを取得します。

パラメータ (クエリ)

// 返されるリストから除外される、先頭のテスト結果ログエントリの数。
offset: integer

// 返されるテスト結果ログエントリの最大数。<br>*注*: 制限の最大値は、システム環境変数のLIMIT_MAX_VALUEを設定することで変更できます。LIMIT_MAX_VALUEの許容範囲は1000～2147483647です。
limit: integer //default: 1000

ヘッダー

// POST /auth エンドポイントから返される access_token。
authorization: string

レスポンス

200 テスト結果ログが正常に取得されました。

application/json

// 単一のテスト結果のログエントリのページ区切りリスト。
{
// 制限やオフセットが適用される前の、リクエストに一致するアイテムの合計数。
total_count: integer
// このリクエストが行われた日時。
date_as_of: string
// 特定のテスト結果からの単一のログエントリ。
items: {
// このログエントリが含まれるテスト結果のID。
test_result_id: integer
// このログエントリが作成されたタイムスタンプ。
timestamp: string
// このテスト結果のログエントリで伝えられるメッセージ。
message: string
// 単一のテスト結果のログエントリの重大度レベル。
severity: enum[CRITICAL, ERROR, WARNING, INFO, DEBUG]
}[]
}

400 不正なリクエスト

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

403 アクセスが拒否されました

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

404 テスト結果が見つかりません

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

422 検証エラー

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

[GET] /test_results/{test_result_id}/screenshots

まとめ:
テストに利用可能なスクリーンショットを一覧表示する

説明:
指定された test_result_id で指定されたテストで使用可能なスクリーンショットのページ区切りリストを取得します。

パラメータ (クエリ)

//
// 返されるリストから除外される、開始時点で利用可能なスクリーンショットの数。
//
offset: integer

//
// 返されるスクリーンショットの最大数。<br>
// *デフォルト値* : null
//
limit: integer //default: 1000

ヘッダー

// POST /auth エンドポイントから返される access_token。
authorization: 文字列

レスポンス

利用可能なスクリーンショット 200 枚が正常に取得されました。

application/json

// 単一のテスト結果で利用可能なスクリーンショットのページネーション付きリスト。
{
  // 制限やオフセットが適用される前に、リクエストに一致するアイテムの総数。
  total_count: integer
  // このリクエストが行われた日時。
  date_as_of: string
  // 特定のテスト結果における利用可能なスクリーンショットの情報。
  items: {
    // このスクリーンショットのアーティファクト ID。
    id: string
    // このスクリーンショットが作成されたタイムスタンプ。
    timestamp: string
    // このスクリーンショットの画像フォーマット。
    content_type: string
  }[]
}

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

403 アクセスが拒否されました

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

404 テスト結果が見つかりません

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

422 検証エラー

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

[GET] /screenshots/{screenshot_id}

まとめ:
テスト結果のスクリーンショットをダウンロードする

説明:
指定された screenshot_id のスクリーンショットをダウンロードします。

Headers

// POST /auth エンドポイントから返される access_token。
authorization:string

レスポンス

200 対象のスクリーンショット（バイト単位）。

image/png image/tiff image/jpeg

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

404 テスト結果のスクリーンショットが見つかりません。

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

422 検証エラー

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

References

AuthRequestBody

{
  client_id: string
  client_secret: string
}

AuthResponseBody

{
  access_token: string
  expires_in: integer
}

HTTPValidationError

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

問題

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
}

RunType

{
  "type": "string",
  "enum": [
    "SCRIPTED_TEST_CASE",
    "MODEL_TEST_CASE",
    "EXPLORATORY",
    "REPLAY",
    "GHERKIN"
  ],
  "title": "RunType",
  "description": "The possible run types for a particular test result."
}

Screenshot

// Info of an available screenshot for a particular test result.
{
  // The artifact id of this screenshot.
  id: string
  // The timestamp when this screenshot was created.
  timestamp: string
  // The image format of this screenshot.
  content_type: string
}

スクリーンショットページ区切りリスト

// 単一のテスト結果で利用可能なスクリーンショットのページネーション付きリスト。
{
  // 制限やオフセットが適用される前に、リクエストに一致するアイテムの総数。
  total_count: integer
  // このリクエストが行われた日時。
  date_as_of: string
  // 特定のテスト結果における利用可能なスクリーンショットの情報。
  items: {
    // このスクリーンショットのアーティファクト ID。
    id: string
    // このスクリーンショットが作成されたタイムスタンプ。
    timestamp: string
    // このスクリーンショットの画像フォーマット。
    content_type: string
  }[]
}

Severity

{
  "type": "string",
  "enum": [
    "CRITICAL",
    "ERROR",
    "WARNING",
    "INFO",
    "DEBUG"
  ],
  "title": "Severity",
  "description": "The severity levels of a single test result log entry."
}

SortBy

{
  "type": "string",
  "enum": [
    "id",
    "model_or_suite_name",
    "start_time",
    "test_case_name",
    "test_config_name",
    "execution_environment_name",
    "sut_name"
  ],
  "title": "SortBy",
  "description": "The possible sorting options available for sorting a list of test results."
}

SortDirection

{
  "type": "string",
  "enum": [
    "asc",
    "desc"
  ],
  "title": "SortDirection",
  "description": "The possible direction applied during sorting."
}

Status

{
  "type": "string",
  "enum": [
    "RUNNING",
    "PASSED",
    "FAILED",
    "ERROR",
    "CANCELLED"
  ],
  "title": "Status",
  "description": "The possible statuses for a particular test result."
}

TestResult

// 単一の探索実行（exploratory）、リプレイ（replay）、またはテストケース実行に関するすべての情報を含むテスト結果。
{
  // テスト結果の ID。
  id: integer
  // 特定のテスト結果における可能なステータス。
  status: enum[RUNNING, PASSED, FAILED, ERROR, CANCELLED]
  // 特定のテスト結果における可能な実行タイプ。
  run_type: enum[SCRIPTED_TEST_CASE, MODEL_TEST_CASE, EXPLORATORY, REPLAY, GHERKIN]
  // このテスト結果がテスト構成で設定された再実行試行の一部であるかどうか。
  is_rerun: boolean
  // テスト実行の開始時刻。
  start_time: string
  // テスト実行の完了時刻。実行中の場合は null。
  end_time: Partial(string) & Partial(null)
  // テスト実行に使用されたモデル名。スクリプト化されたテストケース結果の場合は null。
  model_name: Partial(string) & Partial(null)
  // テスト実行に使用されたモデルの ID。スクリプト化されたテストケース結果の場合は null。
  model_id: Partial(string) & Partial(null)
  // テスト実行に使用されたスイート名。
  suite_name: Partial(string) & Partial(null)
  // テスト実行に使用されたスイートの ID。
  suite_id: Partial(string) & Partial(null)
  // 実行中のテストケース名。探索実行またはリプレイ実行の場合は null。
  test_case_name: Partial(string) & Partial(null)
  // 実行されたテストケースの ID。探索実行またはリプレイ実行の場合は null。
  test_case_id: Partial(string) & Partial(null)
  // テスト実行に使用された設計または実行エージェントの名前。
  execution_environment_name: Partial(string) & Partial(null)
  // テスト実行に使用された設計または実行エージェントの ID。
  execution_environment_id: Partial(integer) & Partial(null)
  // テスト実行に使用された SUT（System Under Test）の名前。
  sut_name: Partial(string) & Partial(null)
  // テスト実行に使用された SUT の ID。
  sut_id: Partial(string) & Partial(null)
  // このテスト結果が属するテスト構成結果の ID。ライブ実行の場合は null。
  test_config_result_id: Partial(string) & Partial(null)
  // このテスト結果が表すテスト構成ステップ。0 から始まるインデックスであり、ライブ実行結果の場合は null。
  test_config_step: Partial(integer) & Partial(null)
}

TestResultLogEntriesPaginatedList

// 単一のテスト結果に対応するログエントリのページネーション付きリスト。
{
  // 制限やオフセットが適用される前に、リクエストに一致するアイテムの総数。
  total_count: integer
  // このリクエストが行われた日時。
  date_as_of: string
  // 特定のテスト結果における単一のログエントリ。
  items: {
    // このログエントリが属するテスト結果の ID。
    test_result_id: integer
    // このログエントリが作成されたタイムスタンプ。
    timestamp: string
    // このテスト結果のログエントリで伝えられるメッセージ。
    message: string
    // 単一のテスト結果ログエントリの重大度レベル。
    severity: enum[CRITICAL, ERROR, WARNING, INFO, DEBUG]
  }[]
}

TestResultLogEntry

// 特定のテスト結果における単一のログエントリ。
{
  // このログエントリが属するテスト結果の ID。
  test_result_id: integer
  // このログエントリが作成されたタイムスタンプ。
  timestamp: string
  // このテスト結果ログエントリで伝えられるメッセージ。
  message: string
  // 単一のテスト結果ログエントリの重大度レベル。
  severity: enum[CRITICAL, ERROR, WARNING, INFO, DEBUG]
}

TestResultsPaginatedList

// テスト結果のページネーション付きリスト。
{
  // 制限やオフセットが適用される前に、リクエストに一致するアイテムの総数。
  total_count: integer
  // このリクエストが行われた日時。
  date_as_of: string
  // 単一の探索実行、リプレイ、またはテストケース実行に関するすべての情報を含むテスト結果。
  items: {
    // テスト結果の ID。
    id: integer
    // 特定のテスト結果における可能なステータス。
    status: enum[RUNNING, PASSED, FAILED, ERROR, CANCELLED]
    // 特定のテスト結果における可能な実行タイプ。
    run_type: enum[SCRIPTED_TEST_CASE, MODEL_TEST_CASE, EXPLORATORY, REPLAY, GHERKIN]
    // このテスト結果がテスト構成で設定された再実行試行の一部であるかどうか。
    is_rerun: boolean
    // テスト実行の開始時刻。
    start_time: string
    // テスト実行の完了時刻。実行中の場合は null。
    end_time: Partial(string) & Partial(null)
    // テスト実行に使用されたモデル名。スクリプト化されたテストケース結果の場合は null。
    model_name: Partial(string) & Partial(null)
    // テスト実行に使用されたモデルの ID。スクリプト化されたテストケース結果の場合は null。
    model_id: Partial(string) & Partial(null)
    // テスト実行に使用されたスイート名。
    suite_name: Partial(string) & Partial(null)
    // テスト実行に使用されたスイートの ID。
    suite_id: Partial(string) & Partial(null)
    // 実行中のテストケース名。探索実行またはリプレイ実行の場合は null。
    test_case_name: Partial(string) & Partial(null)
    // 実行されたテストケースの ID。探索実行またはリプレイ実行の場合は null。
    test_case_id: Partial(string) & Partial(null)
    // テスト実行に使用された設計または実行エージェントの名前。
    execution_environment_name: Partial(string) & Partial(null)
    // テスト実行に使用された設計または実行エージェントの ID。
    execution_environment_id: Partial(integer) & Partial(null)
    // テスト実行に使用された SUT（System Under Test）の名前。
    sut_name: Partial(string) & Partial(null)
    // テスト実行に使用された SUT の ID。
    sut_id: Partial(string) & Partial(null)
    // このテスト結果が属するテスト構成結果の ID。ライブ実行の場合は null。
    test_config_result_id: Partial(string) & Partial(null)
    // このテスト結果が表すテスト構成ステップ。0 から始まるインデックスであり、ライブ実行結果の場合は null。
    test_config_step: Partial(integer) & Partial(null)
  }[]
}

ValidationError

{
  loc: Partial(string) & Partial(integer)[]
  msg: string
  type: string
}

Eggplant パブリック API​

パステーブル​

参照表​

パスの詳細​

[POST] /auth​

RequestBody​

レスポンス​

200 OK​

401 Unauthorized​

422 検証エラー​

[GET] /test_results​

パラメータ (クエリ)​

ヘッダー​

Responses​

200 OK​

400 Bad request​

401 Unauthorized​

422 検証エラー​

[GET] /test_results/{test_result_id}​

Headers​

レスポンス​

200 テスト結果が正常に取得されました​

400 Bad request​

401 Unauthorized​

403 アクセスが拒否されました​

404 テスト結果が見つかりません​

422 検証エラー​

[GET] /test_results/{test_result_id}/logs​

パラメータ (クエリ)​

ヘッダー​

レスポンス​

200 テスト結果ログが正常に取得されました。​

400 不正なリクエスト​

401 Unauthorized​

403 アクセスが拒否されました​

404 テスト結果が見つかりません​

422 検証エラー​

[GET] /test_results/{test_result_id}/screenshots​

パラメータ (クエリ)​

ヘッダー​

レスポンス​

利用可能なスクリーンショット 200 枚が正常に取得されました。​

400 Bad request​

401 Unauthorized​

403 アクセスが拒否されました​

404 テスト結果が見つかりません​

422 検証エラー​

[GET] /screenshots/{screenshot_id}​

Headers​

レスポンス​

200 対象のスクリーンショット（バイト単位）。​

400 Bad request​

401 Unauthorized​

404 テスト結果のスクリーンショットが見つかりません。​

422 検証エラー​

References​

AuthRequestBody​

AuthResponseBody​

HTTPValidationError​

問題​

RunType​

Screenshot​

スクリーンショットページ区切りリスト​

Severity​

SortBy​

SortDirection​

Status​

TestResult​

TestResultLogEntriesPaginatedList​

TestResultLogEntry​

TestResultsPaginatedList​

ValidationError​

Eggplant パブリック API

パステーブル

参照表

パスの詳細

[POST] /auth

RequestBody

レスポンス

200 OK

401 Unauthorized

422 検証エラー

[GET] /test_results

パラメータ (クエリ)

ヘッダー

Responses

200 OK

400 Bad request

401 Unauthorized

422 検証エラー

[GET] /test_results/{test_result_id}

Headers

レスポンス

200 テスト結果が正常に取得されました

400 Bad request

401 Unauthorized

403 アクセスが拒否されました

404 テスト結果が見つかりません

422 検証エラー

[GET] /test_results/{test_result_id}/logs

パラメータ (クエリ)

ヘッダー

レスポンス

200 テスト結果ログが正常に取得されました。

400 不正なリクエスト

401 Unauthorized

403 アクセスが拒否されました

404 テスト結果が見つかりません

422 検証エラー

[GET] /test_results/{test_result_id}/screenshots

パラメータ (クエリ)

ヘッダー

レスポンス

利用可能なスクリーンショット 200 枚が正常に取得されました。

400 Bad request

401 Unauthorized

403 アクセスが拒否されました

404 テスト結果が見つかりません

422 検証エラー

[GET] /screenshots/{screenshot_id}

Headers

レスポンス

200 対象のスクリーンショット（バイト単位）。

400 Bad request

401 Unauthorized

404 テスト結果のスクリーンショットが見つかりません。

422 検証エラー

References

AuthRequestBody

AuthResponseBody

HTTPValidationError

問題

RunType

Screenshot

スクリーンショットページ区切りリスト

Severity

SortBy

SortDirection

Status

TestResult

TestResultLogEntriesPaginatedList

TestResultLogEntry

TestResultsPaginatedList

ValidationError